数据集(Dataset)

[GET] /api/v2/data/datasets/{id}/query

查询数据集。

参数

名称	类型	位置	描述
id必填项	string	path

响应

状态代码: 200

成功

二进制

状态代码: 400

错误请求

BadRequstResult

[POST] /api/v2/data/datasets/{id}/query

查询数据集。

参数

名称	类型	位置	描述
id必填项	string	path

响应

状态代码: 200

成功

二进制

状态代码: 400

错误请求

BadRequstResult

[POST] /api/v2/data/datasets/{id}/export

导出数据集文件。

参数

名称	类型	位置	描述
id必填项	string	path	数据集文档 ID。 例如： 4d4dc304-8ae5-16e4-c790-a8b87a7246b2

请求模式

DatasetExportModel

响应

状态代码: 200

成功

二进制

状态代码: 400

错误请求

DatasetPluginError

[PUT] /api/v2/data/datasets/cached-datasets/batch-refresh

批量刷新数据集数据。

请求模式

BatchRefreshDatasetRequestModel

响应

状态代码: 200

Success

BatchRefreshDatasetTaskResultModel

状态代码: 400

错误请求

DatasetPluginError

[GET] /api/v2/data/datasets/{id}/download

下载一份数据集文件。

参数

名称	类型	位置	描述
id必填项	string	path	文档ID。 例如：15fd3940-e83c-19d7-246d-81b2ccb7e195

响应

状态代码: 200

成功

二进制

状态代码: 400

错误请求

DatasetPluginError

状态代码: 404

未发现

DatasetPluginError

[GET] /api/v2/data/datasets/cached-datasets/list

列出缓存数据集的所有缓存数据。

响应

状态代码: 200

成功

DatasetCachesResultModel

状态代码: 400

错误请求

DatasetPluginError

[POST] /api/v2/data/datasets/pushdatasets/{datasetId}/data

通过datasetId添加推送数据集数据。

参数

名称	类型	位置	描述
datasetId必填项	string	path	文档ID。 例如：96f08381-f07c-3b0f-5f43-e84491b1616b
pushDataToken	string	query	Push data token

请求模式

InsertPushDataModel

响应

状态代码: 204

成功

状态代码: 400

错误请求

DatasetPluginError

[DELETE] /api/v2/data/datasets/pushdatasets/{datasetId}/data

根据条件，按datasetId删除推送数据集数据。

参数

名称	类型	位置	描述
datasetId必填项	string	path	数据集 ID。 例如：96f08381-f07c-3b0f-5f43-e84491b1616b
pushDataToken	string	query	推送数据令牌

请求数据格式

ClearPushDataModel

响应

状态代码: 204

成功

状态代码: 400

错误请求

DatasetPluginError

[POST] /api/v2/data/datasets/streamingdatasets/{datasetId}/data

按id添加流式数据集数据。

参数

名称	类型	位置	描述
datasetId必填项	string	path	数据集 ID。 例如： 006fa63d-2b21-0433-5785-9c8751dba0b4
pushDataToken	string	query	推送数据令牌

请求模式

InsertStreamingDataModel

响应

状态代码: 204

成功

状态代码: 400

错误请求

DatasetPluginError

模型定义

Ƭ BadRequstResult

代表一个错误的响应模型。

名称	类型	描述	示例
errorCode可为空	string	错误代码。
errorDataDict可为空	string	错误数据字典。
innerError	InnerError

Ƭ InnerError

代表一个内部模型。

名称	类型	描述	示例
errorCode可为空	string	错误代码。
errorDataDict可为空	string	错误数据字典。
message可为空	string	错误消息。
inner	InnerError

Ƭ DatasetPluginError

名称	类型	描述	示例
code可为空	string	错误代码
message可为空	string	错误信息
context可为空	string	错误上下文
innerError	DatasetPluginError

Ƭ DatasetExportModel

代表一个数据集的输出模型。

名称	类型	描述	示例
parameters可为空	DatasetParameterItem	数据集导出参数。
advancedSetting	ExportAdvancedSetting
fileType可为空	string	数据集导出文件类型。	"JSON"

Ƭ DatasetParameterItem

代表一个数据集参数项。

名称	类型	描述	示例
name可为空	string	数据集导出参数名称。	"age"
value可为空	Array	数据集导出参数值。	[18,21]

Ƭ ExportAdvancedSetting

代表一个数据集导出的高级设置。

名称	类型	描述	示例
encoding可为空	string	csv 文件编码。	"utf-8"
noHeader	Boolean	Get or set whether csv file has header.	true
columnsDelimiter可为空	string	csv 文件列分隔符。	","
rowsDelimiter可为空	string	csv 文件行分隔符。	";"
formatted	Boolean	Get or set whether json file is formated.	true
quotePropertyNames	Boolean	Get or set json file quote property names.	true
limit	int32	Get or set file limit size.	100

Ƭ BatchRefreshDatasetTaskResultModel

代表批量刷新任务的结果模型。

名称	类型	描述	示例
datasetId可为空	string	数据集文档 ID。
success	Boolean	Get or set result of batch refresh task.
errorCode可为空	string	任务失败时错误代码。
errorMessage可为空	string	任务失败时的错误消息。
taskId可为空	string	批量刷新任务 ID。

Ƭ BatchRefreshDatasetRequestModel

代表一个批量刷新模型。

名称	类型	描述	示例
refreshDataSetIds	Array<string>	刷新数据集 ID。	["789ACE15-1C11-DFD0-312D-AA32EBA0AB67","51FC17FF-D490-42E1-D419-E7BBC83CCF53"]
cotSearchEntryInfos可为空	SearchEntryInfo	COT 搜索条目信息。

Ƭ SearchEntryInfo

代表一个COT搜索条目信息。

名称	类型	描述	示例
tenantId可为空	string	租户 ID。	"D2DA4850-FBD0-7022-E471-E3AEDAA140E3"
datasetId可为空	string	数据集 ID。	"E2DD8243-8CD3-39F7-8FAE-E23E6AE0ECF2"

Ƭ DatasetCachesResultModel

代表一个获取数据集缓存的结果模型。

名称	类型	描述	示例
lastErrorData可为空	string	数据集缓存上次刷新错误数据
datasetId可为空	string	数据集文档 ID。
title可为空	string	数据集文档标题。
displayName可为空	string	数据集缓存显示名称。
creatorName可为空	string	数据集文档创建者姓名。
tenantId可为空	string	租户ID。
rowCount	int64	Dataset cache data row count.
operation可为空	string	数据集缓存操作。
lastUpdated可为空	ISO DateTime Sting	数据集缓存上次更新时间。

Ƭ InsertPushDataModel

添加推送数据集数据

名称	类型	描述	示例
columns	Array<string>	推送数据集数据列	["id","name"]
rows	Array<array>	推送数据集数据行	[[0,"Lisa"],[1,"Bob"]]
overwrite	Boolean	是否完全覆盖旧数据	true

Ƭ ClearPushDataModel

清除推送数据集的数据

名称	类型	描述	示例
columnName可为空	string	推送数据集的数据列名称	"name"
value可为空	any	推送数据集的数据列值	"Lisa"
option可为空	string	它支持，用于where子句的选项。 >, <, =	"="

Ƭ InsertStreamingDataModel

添加推送数据集数据

名称	类型	描述	示例
columns	Array<string>	流式数据集的数据列	["id","name"]
rows	Array<array>	流式数据集的数据行	[[0,"Lisa"],[1,"Bob"]]
overwrite	Boolean	是否完全覆盖旧数据	true